Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document clarifying notes about the data lifecycle #5921

Closed
wants to merge 3 commits into from
Closed

Document clarifying notes about the data lifecycle #5921

wants to merge 3 commits into from

Conversation

popojk
Copy link
Contributor

@popojk popojk commented Oct 26, 2024 •
edited
Loading

Tracking issue

Closes #4683

Why are the changes needed?

  1. The Understand How Flyte Handles Data doc is lacking information about deleting raw data in storage service such as s3 and gcs.
  2. Some example code in the doc is incorrect. The workflow called a function 'task_read_and_shuffle_file', but the function is not defined in example code.

What changes were proposed in this pull request?

  1. Add information about raw data deletion in the doc.
  2. Fix example code.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All commits are signed-off.

Docs link

https://flyte--5921.org.readthedocs.build/en/5921/user_guide/concepts/main_concepts/data_management.html

@popojk
add information about deleting raw data in data_management.rst
ccf509b 
Signed-off-by: Alex Wu <c.alexwu@gmail.com>
@popojk
fix example code error
f086562 
Signed-off-by: Alex Wu <c.alexwu@gmail.com>
@codecov Codecov
Copy link

codecov bot commented Oct 26, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (1279740) to head (3d88187).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #5921      +/-   ##
==========================================
+ Coverage   36.53%   36.84%   +0.31%     
==========================================
  Files        1249     1309      +60     
  Lines      128230   130967    +2737     
==========================================
+ Hits        46847    48259    +1412     
- Misses      77346    78524    +1178     
- Partials     4037     4184     +147
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (?)
unittests-flyteadmin 54.14% <ø> (ø)
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.00% <ø> (ø)
unittests-flytestdlib 55.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@popojk
delete example code task decorator arguments
3d88187 
Signed-off-by: Alex Wu <c.alexwu@gmail.com>
@popojk popojk closed this Oct 27, 2024
@popojk popojk deleted the document-clarifying-notes-about-the-data-lifecycle branch October 27, 2024 13:00
@popojk popojk restored the document-clarifying-notes-about-the-data-lifecycle branch October 27, 2024 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neverett neverett Awaiting requested review from neverett neverett is a code owner

@ppiegaze ppiegaze Awaiting requested review from ppiegaze ppiegaze is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] document clarifying notes about the data lifecycle
1 participant
@popojk